

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>nlp_architect.data.cdc_resources.embedding.embed_elmo &mdash; NLP Architect by Intel® AI Lab 0.5.2 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../../../../../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
        <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
        <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
        <script type="text/javascript" src="../../../../../_static/language_data.js"></script>
        <script type="text/javascript" src="../../../../../_static/install.js"></script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../../../../../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../../../../_static/nlp_arch_theme.css" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:100,900" type="text/css" />
    <link rel="index" title="Index" href="../../../../../genindex.html" />
    <link rel="search" title="Search" href="../../../../../search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../../../../../index.html">
          

          
            
            <img src="../../../../../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../quick_start.html">Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../tutorials.html">Jupyter Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../model_zoo.html">Model Zoo</a></li>
</ul>
<p class="caption"><span class="caption-text">NLP/NLU Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../tagging/sequence_tagging.html">Sequence Tagging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../sentiment.html">Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../bist_parser.html">Dependency Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../intent.html">Intent Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../lm.html">Language Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../information_extraction.html">Information Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../transformers.html">Transformers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../archived/additional.html">Additional Models</a></li>
</ul>
<p class="caption"><span class="caption-text">Optimized Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../quantized_bert.html">Quantized BERT</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../transformers_distillation.html">Transformers Distillation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../sparse_gnmt.html">Sparse Neural Machine Translation</a></li>
</ul>
<p class="caption"><span class="caption-text">Solutions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../absa_solution.html">Aspect Based Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../term_set_expansion.html">Set Expansion</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../trend_analysis.html">Trend Analysis</a></li>
</ul>
<p class="caption"><span class="caption-text">For Developers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../generated_api/nlp_architect_api_index.html">nlp_architect API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../developer_guide.html">Developer Guide</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../../../index.html">NLP Architect by Intel® AI Lab</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../../../index.html">Module code</a> &raquo;</li>
        
      <li>nlp_architect.data.cdc_resources.embedding.embed_elmo</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>Source code for nlp_architect.data.cdc_resources.embedding.embed_elmo</h1><div class="highlight"><pre>
<span></span><span class="c1"># ******************************************************************************</span>
<span class="c1"># Copyright 2017-2018 Intel Corporation</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1"># ******************************************************************************</span>

<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">pickle</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>

<span class="kn">from</span> <span class="nn">nlp_architect.common.cdc.mention_data</span> <span class="kn">import</span> <span class="n">MentionDataLight</span>
<span class="kn">from</span> <span class="nn">nlp_architect.utils.embedding</span> <span class="kn">import</span> <span class="n">ELMoEmbedderTFHUB</span>

<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<div class="viewcode-block" id="ElmoEmbedding"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbedding">[docs]</a><span class="k">class</span> <span class="nc">ElmoEmbedding</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Loading Elmo Embedding module&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span> <span class="o">=</span> <span class="n">ELMoEmbedderTFHUB</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">cache</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Elmo Embedding module lead successfully&quot;</span><span class="p">)</span>

<div class="viewcode-block" id="ElmoEmbedding.get_head_feature_vector"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbedding.get_head_feature_vector">[docs]</a>    <span class="k">def</span> <span class="nf">get_head_feature_vector</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mention</span><span class="p">:</span> <span class="n">MentionDataLight</span><span class="p">):</span>
        <span class="k">if</span> <span class="n">mention</span><span class="o">.</span><span class="n">mention_context</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">mention</span><span class="o">.</span><span class="n">mention_context</span><span class="p">:</span>
            <span class="n">sentence</span> <span class="o">=</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mention</span><span class="o">.</span><span class="n">mention_context</span><span class="p">)</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">apply_get_from_cache</span><span class="p">(</span><span class="n">sentence</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">mention</span><span class="o">.</span><span class="n">tokens_number</span><span class="p">)</span>

        <span class="n">sentence</span> <span class="o">=</span> <span class="n">mention</span><span class="o">.</span><span class="n">tokens_str</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">apply_get_from_cache</span><span class="p">(</span><span class="n">sentence</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="p">[])</span></div>

<div class="viewcode-block" id="ElmoEmbedding.apply_get_from_cache"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbedding.apply_get_from_cache">[docs]</a>    <span class="k">def</span> <span class="nf">apply_get_from_cache</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sentence</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">context</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">indexs</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
        <span class="k">if</span> <span class="n">context</span> <span class="ow">and</span> <span class="n">indexs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">sentence</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache</span><span class="p">:</span>
                <span class="n">elmo_full_vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache</span><span class="p">[</span><span class="n">sentence</span><span class="p">]</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">elmo_full_vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="o">.</span><span class="n">get_vector</span><span class="p">(</span><span class="n">sentence</span><span class="o">.</span><span class="n">split</span><span class="p">())</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">cache</span><span class="p">[</span><span class="n">sentence</span><span class="p">]</span> <span class="o">=</span> <span class="n">elmo_full_vec</span>

            <span class="n">elmo_ret_vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_mention_vec_from_sent</span><span class="p">(</span><span class="n">elmo_full_vec</span><span class="p">,</span> <span class="n">indexs</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">sentence</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache</span><span class="p">:</span>
                <span class="n">elmo_ret_vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache</span><span class="p">[</span><span class="n">sentence</span><span class="p">]</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">elmo_ret_vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_elmo_avg</span><span class="p">(</span><span class="n">sentence</span><span class="o">.</span><span class="n">split</span><span class="p">())</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">cache</span><span class="p">[</span><span class="n">sentence</span><span class="p">]</span> <span class="o">=</span> <span class="n">elmo_ret_vec</span>

        <span class="k">return</span> <span class="n">elmo_ret_vec</span></div>

<div class="viewcode-block" id="ElmoEmbedding.get_avrg_feature_vector"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbedding.get_avrg_feature_vector">[docs]</a>    <span class="k">def</span> <span class="nf">get_avrg_feature_vector</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tokens_str</span><span class="p">):</span>
        <span class="k">if</span> <span class="n">tokens_str</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">apply_get_from_cache</span><span class="p">(</span><span class="n">tokens_str</span><span class="p">)</span>
        <span class="k">return</span> <span class="kc">None</span></div>

<div class="viewcode-block" id="ElmoEmbedding.get_elmo_avg"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbedding.get_elmo_avg">[docs]</a>    <span class="k">def</span> <span class="nf">get_elmo_avg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sentence</span><span class="p">):</span>
        <span class="n">sentence_embedding</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="o">.</span><span class="n">get_vector</span><span class="p">(</span><span class="n">sentence</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">sentence_embedding</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></div>

<div class="viewcode-block" id="ElmoEmbedding.get_mention_vec_from_sent"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbedding.get_mention_vec_from_sent">[docs]</a>    <span class="nd">@staticmethod</span>
    <span class="k">def</span> <span class="nf">get_mention_vec_from_sent</span><span class="p">(</span><span class="n">sent_vec</span><span class="p">,</span> <span class="n">indexs</span><span class="p">):</span>
        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">indexs</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
            <span class="n">elmo_ret_vec</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">sent_vec</span><span class="p">[</span><span class="n">indexs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="p">:</span> <span class="n">indexs</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="mi">1</span><span class="p">],</span> <span class="n">axis</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">elmo_ret_vec</span> <span class="o">=</span> <span class="n">sent_vec</span><span class="p">[</span><span class="n">indexs</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>

        <span class="k">return</span> <span class="n">elmo_ret_vec</span></div></div>


<div class="viewcode-block" id="ElmoEmbeddingOffline"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbeddingOffline">[docs]</a><span class="k">class</span> <span class="nc">ElmoEmbeddingOffline</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dump_file</span><span class="p">):</span>
        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Loading Elmo Offline Embedding module&quot;</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">dump_file</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">dump_file</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">out</span><span class="p">:</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;Elmo Offline without loaded embeder!&quot;</span><span class="p">)</span>

        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Elmo Offline Embedding module lead successfully&quot;</span><span class="p">)</span>

<div class="viewcode-block" id="ElmoEmbeddingOffline.get_head_feature_vector"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbeddingOffline.get_head_feature_vector">[docs]</a>    <span class="k">def</span> <span class="nf">get_head_feature_vector</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mention</span><span class="p">:</span> <span class="n">MentionDataLight</span><span class="p">):</span>
        <span class="n">embed</span> <span class="o">=</span> <span class="kc">None</span>
        <span class="k">if</span> <span class="n">mention</span><span class="o">.</span><span class="n">mention_context</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">mention</span><span class="o">.</span><span class="n">mention_context</span><span class="p">:</span>
            <span class="n">sentence</span> <span class="o">=</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mention</span><span class="o">.</span><span class="n">mention_context</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">sentence</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="p">:</span>
                <span class="n">elmo_full_vec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="p">[</span><span class="n">sentence</span><span class="p">]</span>
                <span class="k">return</span> <span class="n">ElmoEmbedding</span><span class="o">.</span><span class="n">get_mention_vec_from_sent</span><span class="p">(</span><span class="n">elmo_full_vec</span><span class="p">,</span> <span class="n">mention</span><span class="o">.</span><span class="n">tokens_number</span><span class="p">)</span>

        <span class="n">sentence</span> <span class="o">=</span> <span class="n">mention</span><span class="o">.</span><span class="n">tokens_str</span>
        <span class="k">if</span> <span class="n">sentence</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="p">:</span>
            <span class="n">embed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="p">[</span><span class="n">sentence</span><span class="p">]</span>

        <span class="k">return</span> <span class="n">embed</span></div>

<div class="viewcode-block" id="ElmoEmbeddingOffline.get_avrg_feature_vector"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.embedding.html#nlp_architect.data.cdc_resources.embedding.embed_elmo.ElmoEmbeddingOffline.get_avrg_feature_vector">[docs]</a>    <span class="k">def</span> <span class="nf">get_avrg_feature_vector</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tokens_str</span><span class="p">):</span>
        <span class="n">embed</span> <span class="o">=</span> <span class="kc">None</span>
        <span class="k">if</span> <span class="n">tokens_str</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="p">:</span>
            <span class="n">embed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">embeder</span><span class="p">[</span><span class="n">tokens_str</span><span class="p">]</span>

        <span class="k">return</span> <span class="n">embed</span></div></div>
</pre></div>

           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>